AI_README MCP Server

Created By

Draco Cheng8 days ago

AI_README MCP Server is a Model Context Protocol (MCP) server that helps AI assistants understand your project conventions through dedicated AI_README.md guide files. It automatically discovers, routes, and manages these files so AI can generate consistent, high-quality code that matches your team's standards. Works with: GitHub Copilot (VSCode 1.102+), Claude Code, Cursor, and other MCP-compatible AI tools.

# readme

# documentation

Overview Content Tools Comments

Overview

AI_README MCP Server

MCP server for managing AI_README.md files - provides context to AI assistants about project conventions.

Tech Stack

TypeScript (ES2022, Node16 modules, strict mode)
MCP SDK (@modelcontextprotocol/sdk)
Zod for schema validation
tsup for bundling
tsx for testing

Architecture

src/index.ts - MCP server entry, tool registration
src/tools/ - Tool implementations (discover, getContext, update, validate, init)
src/core/ - Core logic (scanner, router, updater, validator, detector)
src/types/ - TypeScript interfaces and types

Coding Conventions

ESM-only ("type": "module", .js extensions in imports)
Zod schemas for input validation, exported alongside tools
Tool functions return structured objects, server wraps as JSON
Prefer fs-extra over native fs
Use glob package for file pattern matching

Cross-directory dependencies

Tools in src/tools/ import core modules from src/core/
Types exported from src/types/index.ts used everywhere

Server Config

{
  "mcpServers": {
    "ai-readme-manager": {
      "command": "npx",
      "args": [
        "-y",
        "ai-readme-mcp@latest"
      ]
    }
  }
}

Recommend Servers

TraeBuild with Free GPT-4.1 & Claude 3.7. Fully MCP-Ready.

MCP AdvisorMCP Advisor & Installation - Use the right MCP server for your needs

Amap Maps高德地图官方 MCP Server

ChatWiseThe second fastest AI chatbot™

DeepChatYour AI Partner on Desktop

EdgeOne Pages MCPAn MCP service designed for deploying HTML content to EdgeOne Pages and obtaining an accessible public URL.

Visual Studio Code - Open Source ("Code - OSS")Visual Studio Code

Howtocook Mcp基于Anduin2017 / HowToCook （程序员在家做饭指南）的mcp server，帮你推荐菜谱、规划膳食，解决“今天吃什么“的世纪难题； Based on Anduin2017/HowToCook (Programmer's Guide to Cooking at Home), MCP Server helps you recommend recipes, plan meals, and solve the century old problem of "what to eat today"

Serper MCP ServerA Serper MCP Server

Y GuiA web-based graphical interface for AI chat interactions with support for multiple AI models and MCP (Model Context Protocol) servers.

RedisA Model Context Protocol server that provides access to Redis databases. This server enables LLMs to interact with Redis key-value stores through a set of standardized tools.